{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "# 函数基础\n",
    "\n",
    "## 目标\n",
    "\n",
    "* 函数的快速体验\n",
    "* 函数的基本使用\n",
    "* 函数的参数\n",
    "* 函数的返回值\n",
    "* 函数的嵌套调用\n",
    "* 在模块中定义函数\n",
    "\n",
    "## 01. 函数的快速体验\n",
    "\n",
    "### 1.1 快速体验\n",
    "\n",
    "* 所谓**函数**，就是把 **具有独立功能的代码块** 组织为一个小模块，在需要的时候 **调用**\n",
    "* 函数的使用包含两个步骤：\n",
    "    1. 定义函数 —— **封装** 独立的功能\n",
    "    2. 调用函数 —— 享受 **封装** 的成果\n",
    "* **函数的作用**，在开发程序时，使用函数可以提高编写的效率以及代码的 **重用**\n",
    "\n",
    "**演练步骤**\n",
    "\n",
    "1. 新建 `04_函数` 项目\n",
    "2. 复制之前完成的 **乘法表** 文件\n",
    "3. 修改文件，增加函数定义 `multiple_table():`\n",
    "4. 新建另外一个文件，使用 `import` 导入并且调用函数\n",
    "\n",
    "## 02. 函数基本使用\n",
    "\n",
    "### 2.1 函数的定义\n",
    "\n",
    "定义函数的格式如下：\n",
    "\n",
    "```python\n",
    "def 函数名():\n",
    "\n",
    "    函数封装的代码\n",
    "    ……\n",
    "```\n",
    "\n",
    "1. `def` 是英文 `define` 的缩写\n",
    "2. **函数名称** 应该能够表达 **函数封装代码** 的功能，方便后续的调用\n",
    "3. **函数名称** 的命名应该 **符合** **标识符的命名规则**\n",
    "    * 可以由 **字母**、**下划线** 和 **数字** 组成\n",
    "    * **不能以数字开头**\n",
    "    * **不能与关键字重名**\n",
    "\n",
    "### 2.2 函数调用\n",
    "\n",
    "调用函数很简单的，通过 `函数名()` 即可完成对函数的调用\n",
    "\n",
    "### 2.3 第一个函数演练\n",
    "\n",
    "**需求**\n",
    "\n",
    "* 1. 编写一个打招呼 `say_hello` 的函数，封装三行打招呼的代码\n",
    "* 2. 在函数下方调用打招呼的代码\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "小明\n",
      "hello 1\n",
      "hello 2\n",
      "hello 3\n",
      "小明\n"
     ]
    }
   ],
   "source": [
    "name = \"小明\"\n",
    "\n",
    "\n",
    "# 解释器知道这里定义了一个函数\n",
    "def say_hello():\n",
    "    print(\"hello 1\")\n",
    "    print(\"hello 2\")\n",
    "    print(\"hello 3\")\n",
    "\n",
    "print(name)\n",
    "# 只有在调用函数时，之前定义的函数才会被执行\n",
    "# 函数执行完成之后，会重新回到之前的程序中，继续执行后续的代码\n",
    "say_hello()\n",
    "\n",
    "print(name)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "> 用 **单步执行 F8 和 F7** 观察以下代码的执行过程\n",
    "\n",
    "* 定义好函数之后，只表示这个函数封装了一段代码而已\n",
    "* 如果不主动调用函数，函数是不会主动执行的\n",
    "\n",
    "#### 思考\n",
    "\n",
    "* 能否将 **函数调用** 放在 **函数定义** 的上方？\n",
    "\n",
    "    * 不能！\n",
    "    * 因为在 **使用函数名** 调用函数之前，必须要保证 `Python` 已经知道函数的存在\n",
    "    * 否则控制台会提示 `NameError: name 'say_hello' is not defined` (**名称错误：say_hello 这个名字没有被定义**)\n",
    "\n",
    "### 2.4 PyCharm 的调试工具\n",
    "\n",
    "* **F8 Step Over** 可以单步执行代码，会把函数调用看作是一行代码直接执行\n",
    "* **F7 Step Into** 可以单步执行代码，如果是函数，会进入函数内部 \n",
    "\n",
    "### 2.5 函数的文档注释\n",
    "\n",
    "* 在开发中，如果希望给函数添加注释，应该在 **定义函数** 的下方，使用 **连续的三对引号**\n",
    "* 在 **连续的三对引号** 之间编写对函数的说明文字\n",
    "* 在 **函数调用** 位置，使用快捷键 `CTRL + Q` 可以查看函数的说明信息\n",
    "\n",
    "> 注意：因为 **函数体相对比较独立**，**函数定义的上方**，应该和其他代码（包括注释）保留 **两个空行**\n",
    "\n",
    "## 03. 函数的参数\n",
    "\n",
    "**演练需求**\n",
    "\n",
    "1. 开发一个 `sum_2_num` 的函数\n",
    "2. 函数能够实现 **两个数字的求和** 功能\n",
    "\n",
    "演练代码如下：\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "10 + 20 = 30\n"
     ]
    }
   ],
   "source": [
    "def sum_2_num():\n",
    "\n",
    "    num1 = 10\n",
    "    num2 = 20\n",
    "    result = num1 + num2\n",
    "\n",
    "    print(\"%d + %d = %d\" % (num1, num2, result))\n",
    "\n",
    "sum_2_num()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**思考一下存在什么问题**\n",
    "\n",
    "> 函数只能处理 **固定数值** 的相加\n",
    "\n",
    "**如何解决？**\n",
    "\n",
    "* 如果能够把需要计算的数字，在调用函数时，传递到函数内部就好了！\n",
    "\n",
    "### 3.1 函数参数的使用\n",
    "\n",
    "* 在函数名的后面的小括号内部填写 **参数**\n",
    "* 多个参数之间使用 `,` 分隔\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "50 + 20 = 70\n"
     ]
    }
   ],
   "source": [
    "def sum_2_num(num1, num2):\n",
    "\n",
    "    result = num1 + num2\n",
    "    \n",
    "    print(\"%d + %d = %d\" % (num1, num2, result))\n",
    "\n",
    "sum_2_num(50, 20)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### 3.2 参数的作用\n",
    "\n",
    "* **函数**，把 **具有独立功能的代码块** 组织为一个小模块，在需要的时候 **调用**\n",
    "* **函数的参数**，增加函数的 **通用性**，针对 **相同的数据处理逻辑**，能够 **适应更多的数据**\n",
    "    1. 在函数 **内部**，把参数当做 **变量** 使用，进行需要的数据处理\n",
    "    2. 函数调用时，按照函数定义的**参数顺序**，把 **希望在函数内部处理的数据**，**通过参数** 传递\n",
    "\n",
    "### 3.3 形参和实参\n",
    "\n",
    "* **形参**：**定义** 函数时，小括号中的参数，是用来接收参数用的，在函数内部 **作为变量使用**\n",
    "* **实参**：**调用** 函数时，小括号中的参数，是用来把数据传递到 **函数内部** 用的\n",
    "\n",
    "## 04. 函数的返回值\n",
    "\n",
    "* 在程序开发中，有时候，会希望 **一个函数执行结束后，告诉调用者一个结果**，以便调用者针对具体的结果做后续的处理\n",
    "* **返回值** 是函数 **完成工作**后，**最后** 给调用者的 **一个结果**\n",
    "* 在函数中使用 `return` 关键字可以返回结果\n",
    "* 调用函数一方，可以 **使用变量** 来 **接收** 函数的返回结果\n",
    "\n",
    "> 注意：`return` 表示返回，后续的代码都不会被执行\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "计算结果是 30\n"
     ]
    }
   ],
   "source": [
    "def sum_2_num(num1, num2):\n",
    "    \"\"\"对两个数字的求和\"\"\"\n",
    "\n",
    "    return num1 + num2\n",
    "\n",
    "# 调用函数，并使用 result 变量接收计算结果\n",
    "result = sum_2_num(10, 20)\n",
    "\n",
    "print(\"计算结果是 %d\" % result)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 05. 函数的嵌套调用\n",
    "\n",
    "* 一个函数里面 **又调用** 了 **另外一个函数**，这就是 **函数嵌套调用**\n",
    "* 如果函数 `test2` 中，调用了另外一个函数 `test1`\n",
    "    * 那么执行到调用 `test1` 函数时，会先把函数 `test1` 中的任务都执行完\n",
    "    * 才会回到 `test2` 中调用函数 `test1` 的位置，继续执行后续的代码\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "--------------------------------------------------\n",
      "test 2\n",
      "**************************************************\n",
      "test 1\n",
      "**************************************************\n",
      "--------------------------------------------------\n"
     ]
    }
   ],
   "source": [
    "def test1():\n",
    "\n",
    "    print(\"*\" * 50)\n",
    "    print(\"test 1\")\n",
    "    print(\"*\" * 50)\n",
    "\n",
    "\n",
    "def test2():\n",
    "\n",
    "    print(\"-\" * 50)\n",
    "    print(\"test 2\")\n",
    "    \n",
    "    test1()\n",
    "    \n",
    "    print(\"-\" * 50)\n",
    "\n",
    "test2()\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### 函数嵌套的演练 —— 打印分隔线\n",
    "\n",
    "> 体会一下工作中 **需求是多变** 的\n",
    "\n",
    "**需求 1**\n",
    "\n",
    "* 定义一个 `print_line` 函数能够打印 `*` 组成的 **一条分隔线**\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [],
   "source": [
    "def print_line(char):\n",
    "\n",
    "    print(\"*\" * 50)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "**需求 2**\n",
    "\n",
    "* 定义一个函数能够打印 **由任意字符组成** 的分隔线\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [],
   "source": [
    "def print_line(char):\n",
    "\n",
    "    print(char * 50)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "**需求 3**\n",
    "\n",
    "* 定义一个函数能够打印 **任意重复次数** 的分隔线"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [],
   "source": [
    "def print_line(char, times):\n",
    "\n",
    "    print(char * times)\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**需求 4**\n",
    "\n",
    "* 定义一个函数能够打印 **5 行** 的分隔线，分隔线要求符合**需求 3**\n",
    "\n",
    "> 提示：工作中针对需求的变化，应该冷静思考，**不要轻易修改之前已经完成的，能够正常执行的函数**！"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [],
   "source": [
    "def print_line(char, times):\n",
    "\n",
    "    print(char * times)\n",
    "\n",
    "\n",
    "def print_lines(char, times):\n",
    "\n",
    "    row = 0\n",
    "    \n",
    "    while row < 5:\n",
    "        print_line(char, times)\n",
    "\n",
    "        row += 1"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 06. 使用模块中的函数\n",
    "\n",
    "> **模块是 Python 程序架构的一个核心概念**\n",
    "\n",
    "* **模块** 就好比是 **工具包**，要想使用这个工具包中的工具，就需要 **导入 import** 这个模块\n",
    "* 每一个以扩展名 `py` 结尾的 `Python` 源代码文件都是一个 **模块**\n",
    "* 在模块中定义的 **全局变量** 、 **函数** 都是模块能够提供给外界直接使用的工具\n",
    "\n",
    "### 6.1 第一个模块体验\n",
    "\n",
    "**步骤**\n",
    "\n",
    "* 新建 `hm_10_分隔线模块.py`\n",
    "    * 复制 `hm_09_打印多条分隔线.py` 中的内容，**最后一行 `print` 代码除外**\n",
    "    * 增加一个字符串变量\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "* 新建 `体验模块.py` 文件，并且编写以下代码："
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [],
   "source": [
    "# name = \"黑马程序员\"\n",
    "\n",
    "# import hm_10_分隔线模块\n",
    "\n",
    "# hm_10_分隔线模块.print_line(\"-\", 80)\n",
    "# print(hm_10_分隔线模块.name)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### 体验小结\n",
    "\n",
    "* 可以 **在一个 Python 文件** 中 **定义 变量 或者 函数**\n",
    "* 然后在 **另外一个文件中** 使用 `import` 导入这个模块\n",
    "* 导入之后，就可以使用 `模块名.变量` / `模块名.函数` 的方式，使用这个模块中定义的变量或者函数\n",
    "\n",
    "> **模块**可以让 **曾经编写过的代码** 方便的被 **复用**！\n",
    "\n",
    "### 6.2 模块名也是一个标识符\n",
    "\n",
    "* 标示符可以由 **字母**、**下划线** 和 **数字** 组成\n",
    "* **不能以数字开头**\n",
    "* **不能与关键字重名**\n",
    "\n",
    "> 注意：如果在给 Python 文件起名时，**以数字开头** 是无法在 `PyCharm` 中通过导入这个模块的\n",
    "\n",
    "### 6.3 Pyc 文件（了解）\n",
    "\n",
    "> `C` 是 `compiled` **编译过** 的意思\n",
    "\n",
    "**操作步骤**\n",
    "\n",
    "1. 浏览程序目录会发现一个 `__pycache__` 的目录\n",
    "2. 目录下会有一个 `hm_10_分隔线模块.cpython-35.pyc` 文件，`cpython-35` 表示 `Python` 解释器的版本\n",
    "3. 这个 `pyc` 文件是由 Python 解释器将 **模块的源码** 转换为 **字节码**\n",
    "    * `Python` 这样保存 **字节码** 是作为一种启动 **速度的优化**\n",
    "\n",
    "**字节码**\n",
    "\n",
    "* `Python` 在解释源程序时是分成两个步骤的\n",
    "    1. 首先处理源代码，**编译** 生成一个二进制 **字节码**\n",
    "    2. 再对 **字节码** 进行处理，才会生成 CPU 能够识别的 **机器码**\n",
    "\n",
    "* 有了模块的字节码文件之后，下一次运行程序时，如果在 **上次保存字节码之后** 没有修改过源代码，Python 将会加载 .pyc 文件并跳过编译这个步骤\n",
    "* 当 `Python` 重编译时，它会自动检查源文件和字节码文件的时间戳\n",
    "* 如果你又修改了源代码，下次程序运行时，字节码将自动重新创建\n",
    "\n",
    "> 提示：有关模块以及模块的其他导入方式，后续课程还会逐渐展开！\n",
    ">\n",
    "> **模块是 Python 程序架构的一个核心概念**\n",
    "\n"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.2"
  },
  "toc": {
   "base_numbering": 1,
   "nav_menu": {},
   "number_sections": true,
   "sideBar": true,
   "skip_h1_title": false,
   "title_cell": "Table of Contents",
   "title_sidebar": "Contents",
   "toc_cell": false,
   "toc_position": {},
   "toc_section_display": true,
   "toc_window_display": false
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}
